Skip to content

/v1/domains/{domainId}/external-accounts/providers/{connectionId}

Request

Update an external account provider connection

Security
httpAuth
Path
domainIdstring, (uuid)required
connectionIdstring, (uuid)required
Bodyapplication/json
aliasstringrequired
parametersobjectrequired
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/external-accounts/providers/{connectionId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "alias": "string",
    "parameters": {
      "apiKey": "string",
      "secret": "string",
      "type": "Kraken"
    }
  }'

Responses

Success

Bodyapplication/json
idstring, (uuid)read-onlyrequired
domainIdstring, (uuid)read-onlyrequired
aliasstringread-onlyrequired
parametersobjectrequired
connectionStatestringrequired
Enum:"Connected""Disconnected""ConnectionError""InvalidConnection"
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
  "alias": "string",
  "parameters": {
    "apiKey": "string",
    "secret": "string",
    "type": "Kraken"
  },
  "connectionState": "Connected"
}